The Design Notes API > The Design Notes C API > BOOL GetSiteRootForFile()

 

BOOL GetSiteRootForFile()

Description

Determines the site root for the specified Design Notes file.

Arguments

char* filePath, char* siteRootBuf, int siteRootBufMaxLen, {InfoPrefs* infoPrefs}

The first argument is the file handle returned by OpenNotesFile().
The second argument is the buffer where the site root should be stored.
The third argument is the maximum size of siteRootBuf.
The fourth argument is a reference to a struct in which the preferences for the site should be stored.

Returns

A Boolean value indicating whether the operation was successful; stores the site root in siteRootBuf. If infoPrefs is specified, the function also returns the Design Notes preferences for the site. The InfoPrefs struct has two variables: bUseDesignNotes and bUploadDesignNotes, both of type BOOL.